.. _cmlAiGetCurrent:

cmlAiGetCurrent
================================
--------------------------------


SYNOPSYS
`````````````
.. code-block:: none

    VT_I4 cmlAiGetCurrent ([in] VT_I4 BoardID, [in] VT_I4 Axis, [in] VT_I4 Channel, [out] VT_PR8 fCurrent )                     

DESCRIPTION
`````````````  

- 대상 아날로그 입력 채널에 대하여 A/D 변환을 수행하고, 그 값을 전류(Current) 값으로 반환합니다. 

\

- 이 함수의 사용과 호출에 있어, 제공된 ㈜커미조아의 함수 헤더 Visual Basic 에서는 함수의
  첨두어 cml 가 붙지 않습니다.


PARAMETER
`````````````

▶ BoardID : 사용자가 설정한 디바이스(보드) ID. 
 
▶ Axis: 사용자가 제어하고자 하는 축 혹은 노드마스터 ID 번호
 
▶ Channel : 채널 번호. 통합 채널로 관리되는 채널 번호를 의미하며, 상수 값으로 0 (Zero Based) 이상, 
최대 통합 채널수 - 1 이하의 값을 채널 번호로 설정할 수 있습니다. 
 
▶ fCurrent : A/D 결과값을 전류(Current) 값으로 반환합니다. 단, 전압 범위 설정 모드를 3번 (0~20mA) 
또는 6번 (4~20mA) 로 설정해야 합니다. 

RETURN VALUE
`````````````
.. csv-table::
    :widths: 10 90
    :header-rows: 1
    :stub-columns: 0

    Value, Meaning
    -1, 전류 입력 모드 (3번 / 6번 모드) 가 아닌 경우의 전달되는 값
    유효한 값, 3번 모드: 0~20(mA) / 6번 모드 : 4~20(mA)

RETURN VALUE
`````````````
.. csv-table::
    :widths: 10 90
    :header-rows: 1
    :stub-columns: 0

    Value, Meaning
    음수, 수행 실패
    0(ERR_NONE), 수행 성공


EXAMPLE
```````````````

.. code-block:: c++
 :linenos:
 :emphasize-lines: 5

    C/C++ 
    #include “ComiMLink2_SDK.h” 
    #include “ComiMLink2_SDK_Def.h” 
    #define AI_CHANNEL  5 
    Long BoardID = 0; 
    double fCurrent = 0.0f;  
    // 5번 채널의 A/D 결과값을 전류(Current) 값으로 반환합니다. 
    if(cmlAiGetCurrent (BoardID, 0, AI_CHANNEL, &fCurrent ) != ERR_NONE ) 
    { 
    OutputDebugString ( " cmlAiGetCurrent function Fail" ); 
    }